home *** CD-ROM | disk | FTP | other *** search
/ NeXTSTEP 3.2 for Intel / NeXTSTEP 3.2 for Intel.iso / NextLibrary / Documentation / Sybase / DBLIB / Section2 / dbvarylen.nr < prev    next >
Encoding:
Text File  |  1993-04-22  |  1.4 KB  |  52 lines
  1. .Na "dbvarylen" 
  2. .mc |
  3. .Aa
  4. .Fu
  5. Determine whether the specified regular result column's data can vary in length.
  6. .Ih "varying length data"
  7. .Ih "regular column, determining whether data length varies"
  8. .Sy
  9. .Sf "DBBOOL dbvarylen(dbproc, column)"
  10. .Sp "DBPROCESS" "*dbproc"
  11. .Sp "int" "column"
  12. .Co
  13. .Bl
  14. This routine indicates whether a particular regular (\f2i.e.,\f1 non-compute) 
  15. result column's data can vary in length.
  16. It will return TRUE if the result column is derived 
  17. from a database column of type \f2varchar, varbinary, text,\f1 or \f2image\f1.
  18. It will also return TRUE if the source database column is defined as NULL,
  19. meaning that it may contain a null value.
  20. .Bl
  21. This routine is useful with programs that handle ad hoc queries, if
  22. the program needs to be
  23. alerted to the possibility of null or variable length data.
  24. .Bl
  25. You can use \f2dbcoltype()\f1 to get a column's datatype.
  26. .Bz
  27. .Pa
  28. .Pi dbproc
  29. A pointer to the DBPROCESS structure that provides the connection
  30. for a particular front-end/\*S process.  It contains all the
  31. information that \*L uses to manage communications and data between the
  32. front end and \*S.
  33. .Pi column
  34. The number of the regular result column of interest.
  35. The first column is number 1.
  36. .in -.375i
  37. .Re
  38. .br
  39. TRUE or FALSE, indicating whether or not the column's data can vary in length.
  40. \f2dbvarylen()\f1 also returns 
  41. FALSE if the column number is out of range.
  42. .Sa
  43. dbcollen, 
  44. dbcolname, 
  45. dbcoltype, 
  46. dbdata, 
  47. dbdatlen, 
  48. dbnumcols, 
  49. dbprtype,
  50. types
  51. .mc
  52.